/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package cn.tenmg.flink.formats.json.debezium;

import static org.apache.flink.formats.json.JsonFormatOptions.ENCODE_DECIMAL_AS_PLAIN_NUMBER;

import java.util.Collections;
import java.util.HashSet;
import java.util.Set;

import org.apache.flink.annotation.Internal;
import org.apache.flink.api.common.serialization.DeserializationSchema;
import org.apache.flink.api.common.serialization.SerializationSchema;
import org.apache.flink.configuration.ConfigOption;
import org.apache.flink.configuration.ReadableConfig;
import org.apache.flink.formats.common.TimestampFormat;
import org.apache.flink.formats.json.JsonFormatOptions;
import org.apache.flink.formats.json.JsonFormatOptionsUtil;
import org.apache.flink.formats.json.debezium.DebeziumJsonSerializationSchema;
import org.apache.flink.table.api.ValidationException;
import org.apache.flink.table.connector.ChangelogMode;
import org.apache.flink.table.connector.format.DecodingFormat;
import org.apache.flink.table.connector.format.EncodingFormat;
import org.apache.flink.table.connector.sink.DynamicTableSink;
import org.apache.flink.table.data.RowData;
import org.apache.flink.table.factories.DeserializationFormatFactory;
import org.apache.flink.table.factories.DynamicTableFactory;
import org.apache.flink.table.factories.FactoryUtil;
import org.apache.flink.table.factories.SerializationFormatFactory;
import org.apache.flink.table.types.DataType;
import org.apache.flink.table.types.logical.RowType;
import org.apache.flink.types.RowKind;

/**
 * Format factory for providing configured instances of Debezium JSON to RowData
 * {@link DeserializationSchema}.
 */
@Internal
public class DebeziumJsonPlusFormatFactory implements DeserializationFormatFactory, SerializationFormatFactory {

	public static final String IDENTIFIER = "debezium-json-plus";

	@Override
	public DecodingFormat<DeserializationSchema<RowData>> createDecodingFormat(DynamicTableFactory.Context context,
			ReadableConfig formatOptions) {

		FactoryUtil.validateFactoryOptions(this, formatOptions);
		validateDecodingFormatOptions(formatOptions);

		final boolean schemaInclude = formatOptions.get(DebeziumJsonPlusFormatOptions.SCHEMA_INCLUDE);

		final boolean ignoreParseErrors = formatOptions.get(DebeziumJsonPlusFormatOptions.IGNORE_PARSE_ERRORS);

		final boolean convertDeleteToUpdate = formatOptions.get(DebeziumJsonPlusFormatOptions.CONVERT_DELETE_TO_UPDATE);

		final TimestampFormat timestampFormat = JsonFormatOptionsUtil.getTimestampFormat(formatOptions);

		return new DebeziumJsonPlusDecodingFormat(schemaInclude, ignoreParseErrors, convertDeleteToUpdate,
				timestampFormat);
	}

	@Override
	public EncodingFormat<SerializationSchema<RowData>> createEncodingFormat(DynamicTableFactory.Context context,
			ReadableConfig formatOptions) {

		FactoryUtil.validateFactoryOptions(this, formatOptions);
		validateEncodingFormatOptions(formatOptions);

		TimestampFormat timestampFormat = JsonFormatOptionsUtil.getTimestampFormat(formatOptions);
		JsonFormatOptions.MapNullKeyMode mapNullKeyMode = JsonFormatOptionsUtil.getMapNullKeyMode(formatOptions);
		String mapNullKeyLiteral = formatOptions.get(DebeziumJsonPlusFormatOptions.JSON_MAP_NULL_KEY_LITERAL);

		final boolean encodeDecimalAsPlainNumber = formatOptions.get(ENCODE_DECIMAL_AS_PLAIN_NUMBER);

		return new EncodingFormat<SerializationSchema<RowData>>() {

			@Override
			public ChangelogMode getChangelogMode() {
				return ChangelogMode.newBuilder().addContainedKind(RowKind.INSERT)
						.addContainedKind(RowKind.UPDATE_BEFORE).addContainedKind(RowKind.UPDATE_AFTER)
						.addContainedKind(RowKind.DELETE).build();
			}

			@Override
			public SerializationSchema<RowData> createRuntimeEncoder(DynamicTableSink.Context context,
					DataType consumedDataType) {
				final RowType rowType = (RowType) consumedDataType.getLogicalType();
				return new DebeziumJsonSerializationSchema(rowType, timestampFormat, mapNullKeyMode, mapNullKeyLiteral,
						encodeDecimalAsPlainNumber);
			}
		};
	}

	@Override
	public String factoryIdentifier() {
		return IDENTIFIER;
	}

	@Override
	public Set<ConfigOption<?>> requiredOptions() {
		return Collections.emptySet();
	}

	@Override
	public Set<ConfigOption<?>> optionalOptions() {
		Set<ConfigOption<?>> options = new HashSet<>();
		options.add(DebeziumJsonPlusFormatOptions.SCHEMA_INCLUDE);
		options.add(DebeziumJsonPlusFormatOptions.IGNORE_PARSE_ERRORS);
		options.add(DebeziumJsonPlusFormatOptions.TIMESTAMP_FORMAT);
		options.add(DebeziumJsonPlusFormatOptions.JSON_MAP_NULL_KEY_MODE);
		options.add(DebeziumJsonPlusFormatOptions.JSON_MAP_NULL_KEY_LITERAL);
		options.add(ENCODE_DECIMAL_AS_PLAIN_NUMBER);
		return options;
	}

	/** Validator for debezium decoding format. */
	private static void validateDecodingFormatOptions(ReadableConfig tableOptions) {
		JsonFormatOptionsUtil.validateDecodingFormatOptions(tableOptions);
	}

	/** Validator for debezium encoding format. */
	private static void validateEncodingFormatOptions(ReadableConfig tableOptions) {
		JsonFormatOptionsUtil.validateEncodingFormatOptions(tableOptions);

		// validator for {@link SCHEMA_INCLUDE}
		if (tableOptions.get(DebeziumJsonPlusFormatOptions.SCHEMA_INCLUDE)) {
			throw new ValidationException(
					String.format("Debezium JSON serialization doesn't support '%s.%s' option been set to true.",
							IDENTIFIER, DebeziumJsonPlusFormatOptions.SCHEMA_INCLUDE.key()));
		}
	}
}
